This file contains API for mCurrent Sens Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_spi_master.h"
#include "spi_specifics.h"
#include "drv_i2c_master.h"

Data Structures
struct	mcurrentsens_calib_t
	mCurrent Sens calibration data structure. More...
struct	mcurrentsens_t
	mCurrent Sens Click context object. More...
struct	mcurrentsens_cfg_t
	mCurrent Sens Click configuration object. More...

Macros
#define	MCURRENTSENS_REG_ADCDATA 0x00
	mCurrent Sens register map.
#define	MCURRENTSENS_REG_CONFIG0 0x01
#define	MCURRENTSENS_REG_CONFIG1 0x02
#define	MCURRENTSENS_REG_CONFIG2 0x03
#define	MCURRENTSENS_REG_CONFIG3 0x04
#define	MCURRENTSENS_REG_IRQ 0x05
#define	MCURRENTSENS_REG_MUX 0x06
#define	MCURRENTSENS_REG_SCAN 0x07
#define	MCURRENTSENS_REG_TIMER 0x08
#define	MCURRENTSENS_REG_OFFSETCAL 0x09
#define	MCURRENTSENS_REG_GAINCAL 0x0A
#define	MCURRENTSENS_REG_RESERVED_24 0x0B
#define	MCURRENTSENS_REG_RESERVED_8 0x0C
#define	MCURRENTSENS_REG_LOCK 0x0D
#define	MCURRENTSENS_REG_RESERVED_16 0x0E
#define	MCURRENTSENS_REG_CRCCFG 0x0F
#define	MCURRENTSENS_CMD_DEV_ADDR 0x40
	mCurrent Sens SPI command setting.
#define	MCURRENTSENS_CMD_DEV_ADDR_MASK 0xC0
#define	MCURRENTSENS_CMD_REG_ADDR_SHIFT 2
#define	MCURRENTSENS_CMD_REG_ADDR_MASK 0x3C
#define	MCURRENTSENS_CMD_TYPE_STATIC_READ 0x01
#define	MCURRENTSENS_CMD_TYPE_INC_WRITE 0x02
#define	MCURRENTSENS_CMD_TYPE_INC_READ 0x03
#define	MCURRENTSENS_CMD_TYPE_MASK 0x03
#define	MCURRENTSENS_FAST_CMD_CONV_START ( 0x28 \| MCURRENTSENS_CMD_DEV_ADDR )
#define	MCURRENTSENS_FAST_CMD_STANDBY ( 0x2C \| MCURRENTSENS_CMD_DEV_ADDR )
#define	MCURRENTSENS_FAST_CMD_SHUTDOWN ( 0x30 \| MCURRENTSENS_CMD_DEV_ADDR )
#define	MCURRENTSENS_FAST_CMD_FULL_SHUTDOWN ( 0x34 \| MCURRENTSENS_CMD_DEV_ADDR )
#define	MCURRENTSENS_FAST_CMD_FULL_RESET ( 0x38 \| MCURRENTSENS_CMD_DEV_ADDR )
#define	MCURRENTSENS_CONFIG0_VREF_SEL_EXT 0x00
	mCurrent Sens CONFIG0 register setting.
#define	MCURRENTSENS_CONFIG0_VREF_SEL_INT 0x80
#define	MCURRENTSENS_CONFIG0_VREF_SEL_MASK 0x80
#define	MCURRENTSENS_CONFIG0_PARTIAL_SHUTDOWN_EN 0x00
#define	MCURRENTSENS_CONFIG0_PARTIAL_SHUTDOWN_DIS 0x40
#define	MCURRENTSENS_CONFIG0_PARTIAL_SHUTDOWN_MASK 0x40
#define	MCURRENTSENS_CONFIG0_CLK_SEL_EXT 0x00
#define	MCURRENTSENS_CONFIG0_CLK_SEL_INT_NO_OUT 0x20
#define	MCURRENTSENS_CONFIG0_CLK_SEL_INT_OUT 0x30
#define	MCURRENTSENS_CONFIG0_CLK_SEL_MASK 0x30
#define	MCURRENTSENS_CONFIG0_CS_SEL_NONE 0x00
#define	MCURRENTSENS_CONFIG0_CS_SEL_0P9UA 0x04
#define	MCURRENTSENS_CONFIG0_CS_SEL_3P7UA 0x08
#define	MCURRENTSENS_CONFIG0_CS_SEL_15UA 0x0C
#define	MCURRENTSENS_CONFIG0_CS_SEL_MASK 0x0C
#define	MCURRENTSENS_CONFIG0_ADC_MODE_SHUTDOWN 0x00
#define	MCURRENTSENS_CONFIG0_ADC_MODE_STANDBY 0x02
#define	MCURRENTSENS_CONFIG0_ADC_MODE_CONVERSION 0x03
#define	MCURRENTSENS_CONFIG0_ADC_MODE_MASK 0x03
#define	MCURRENTSENS_CONFIG1_PRE_DIV_1 0x00
	mCurrent Sens CONFIG1 register setting.
#define	MCURRENTSENS_CONFIG1_PRE_DIV_2 0x40
#define	MCURRENTSENS_CONFIG1_PRE_DIV_4 0x80
#define	MCURRENTSENS_CONFIG1_PRE_DIV_8 0xC0
#define	MCURRENTSENS_CONFIG1_PRE_DIV_MASK 0xC0
#define	MCURRENTSENS_CONFIG1_OSR_32 0x00
#define	MCURRENTSENS_CONFIG1_OSR_64 0x04
#define	MCURRENTSENS_CONFIG1_OSR_128 0x08
#define	MCURRENTSENS_CONFIG1_OSR_256 0x0C
#define	MCURRENTSENS_CONFIG1_OSR_512 0x10
#define	MCURRENTSENS_CONFIG1_OSR_1024 0x14
#define	MCURRENTSENS_CONFIG1_OSR_2048 0x18
#define	MCURRENTSENS_CONFIG1_OSR_4096 0x1C
#define	MCURRENTSENS_CONFIG1_OSR_8192 0x20
#define	MCURRENTSENS_CONFIG1_OSR_16384 0x24
#define	MCURRENTSENS_CONFIG1_OSR_20480 0x28
#define	MCURRENTSENS_CONFIG1_OSR_24576 0x2C
#define	MCURRENTSENS_CONFIG1_OSR_40960 0x30
#define	MCURRENTSENS_CONFIG1_OSR_49152 0x34
#define	MCURRENTSENS_CONFIG1_OSR_81920 0x38
#define	MCURRENTSENS_CONFIG1_OSR_98304 0x3C
#define	MCURRENTSENS_CONFIG1_OSR_MASK 0x3C
#define	MCURRENTSENS_CONFIG2_BOOST_X0P5 0x00
	mCurrent Sens CONFIG2 register setting.
#define	MCURRENTSENS_CONFIG2_BOOST_X0P66 0x40
#define	MCURRENTSENS_CONFIG2_BOOST_X1 0x80
#define	MCURRENTSENS_CONFIG2_BOOST_X2 0xC0
#define	MCURRENTSENS_CONFIG2_BOOST_MASK 0xC0
#define	MCURRENTSENS_CONFIG2_GAIN_X0P33 0x00
#define	MCURRENTSENS_CONFIG2_GAIN_X1 0x08
#define	MCURRENTSENS_CONFIG2_GAIN_X2 0x10
#define	MCURRENTSENS_CONFIG2_GAIN_X4 0x18
#define	MCURRENTSENS_CONFIG2_GAIN_X8 0x20
#define	MCURRENTSENS_CONFIG2_GAIN_X16 0x28
#define	MCURRENTSENS_CONFIG2_GAIN_X32 0x30
#define	MCURRENTSENS_CONFIG2_GAIN_X64 0x38
#define	MCURRENTSENS_CONFIG2_GAIN_MASK 0x38
#define	MCURRENTSENS_CONFIG2_AZ_MUX_DIS 0x00
#define	MCURRENTSENS_CONFIG2_AZ_MUX_EN 0x04
#define	MCURRENTSENS_CONFIG2_AZ_MUX_MASK 0x04
#define	MCURRENTSENS_CONFIG2_AZ_REF_DIS 0x00
#define	MCURRENTSENS_CONFIG2_AZ_REF_EN 0x02
#define	MCURRENTSENS_CONFIG2_AZ_REF_MASK 0x02
#define	MCURRENTSENS_CONFIG2_RESERVED 0x01
#define	MCURRENTSENS_CONFIG3_CONV_MODE_ONE_SHOT_SHUT 0x00
	mCurrent Sens CONFIG3 register setting.
#define	MCURRENTSENS_CONFIG3_CONV_MODE_ONE_SHOT_STBY 0x80
#define	MCURRENTSENS_CONFIG3_CONV_MODE_CONTINUOUS 0xC0
#define	MCURRENTSENS_CONFIG3_CONV_MODE_MASK 0xC0
#define	MCURRENTSENS_CONFIG3_DATA_FORMAT_24BIT 0x00
#define	MCURRENTSENS_CONFIG3_DATA_FORMAT_32BIT_LEFT 0x10
#define	MCURRENTSENS_CONFIG3_DATA_FORMAT_32BIT_RIGHT 0x20
#define	MCURRENTSENS_CONFIG3_DATA_FORMAT_32BIT_CHID 0x30
#define	MCURRENTSENS_CONFIG3_DATA_FORMAT_MASK 0x30
#define	MCURRENTSENS_CONFIG3_CRC_FORMAT_16BIT 0x00
#define	MCURRENTSENS_CONFIG3_CRC_FORMAT_32BIT 0x08
#define	MCURRENTSENS_CONFIG3_CRC_FORMAT_MASK 0x08
#define	MCURRENTSENS_CONFIG3_EN_CRCCOM_DIS 0x00
#define	MCURRENTSENS_CONFIG3_EN_CRCCOM_EN 0x04
#define	MCURRENTSENS_CONFIG3_EN_CRCCOM_MASK 0x04
#define	MCURRENTSENS_CONFIG3_EN_OFFCAL_DIS 0x00
#define	MCURRENTSENS_CONFIG3_EN_OFFCAL_EN 0x02
#define	MCURRENTSENS_CONFIG3_EN_OFFCAL_MASK 0x02
#define	MCURRENTSENS_CONFIG3_EN_GAINCAL_DIS 0x00
#define	MCURRENTSENS_CONFIG3_EN_GAINCAL_EN 0x01
#define	MCURRENTSENS_CONFIG3_EN_GAINCAL_MASK 0x01
#define	MCURRENTSENS_IRQ_DR_STATUS 0x40
	mCurrent Sens IRQ register setting.
#define	MCURRENTSENS_IRQ_CRCCFG_STATUS 0x20
#define	MCURRENTSENS_IRQ_POR_STATUS 0x10
#define	MCURRENTSENS_IRQ_MODE_IRQ_HIGH_Z 0x00
#define	MCURRENTSENS_IRQ_MODE_IRQ_LOGIC_HIGH 0x04
#define	MCURRENTSENS_IRQ_MODE_MDAT_HIGH_Z 0x08
#define	MCURRENTSENS_IRQ_MODE_MDAT_LOGIC_HIGH 0x0C
#define	MCURRENTSENS_IRQ_MODE_MASK 0x0C
#define	MCURRENTSENS_IRQ_EN_FASTCMD_DIS 0x00
#define	MCURRENTSENS_IRQ_EN_FASTCMD_EN 0x02
#define	MCURRENTSENS_IRQ_EN_FASTCMD_MASK 0x02
#define	MCURRENTSENS_IRQ_EN_STP_DIS 0x00
#define	MCURRENTSENS_IRQ_EN_STP_EN 0x01
#define	MCURRENTSENS_IRQ_EN_STP_MASK 0x01
#define	MCURRENTSENS_MUX_VIN_P_SHIFT 4
	mCurrent Sens MUX register setting.
#define	MCURRENTSENS_MUX_VIN_P_MASK 0xF0
#define	MCURRENTSENS_MUX_VIN_N_SHIFT 0
#define	MCURRENTSENS_MUX_VIN_N_MASK 0x0F
#define	MCURRENTSENS_MUX_CH0 0x00
#define	MCURRENTSENS_MUX_CH1 0x01
#define	MCURRENTSENS_MUX_CH2 0x02
#define	MCURRENTSENS_MUX_CH3 0x03
#define	MCURRENTSENS_MUX_CH4 0x04
#define	MCURRENTSENS_MUX_CH5 0x05
#define	MCURRENTSENS_MUX_CH6 0x06
#define	MCURRENTSENS_MUX_CH7 0x07
#define	MCURRENTSENS_MUX_AGND 0x08
#define	MCURRENTSENS_MUX_AVDD 0x09
#define	MCURRENTSENS_MUX_RESERVED 0x0A
#define	MCURRENTSENS_MUX_REFIN_OUT 0x0B
#define	MCURRENTSENS_MUX_REFIN_IN 0x0C
#define	MCURRENTSENS_MUX_TEMP_P 0x0D
#define	MCURRENTSENS_MUX_TEMP_M 0x0E
#define	MCURRENTSENS_MUX_VCM 0x0F
#define	MCURRENTSENS_MUX_CH1_CURRENT_P MCURRENTSENS_MUX_CH0
	mCurrent Sens board channel mapping.
#define	MCURRENTSENS_MUX_CH1_CURRENT_N MCURRENTSENS_MUX_CH1
#define	MCURRENTSENS_MUX_CH1_VOLTAGE_P MCURRENTSENS_MUX_CH2
#define	MCURRENTSENS_MUX_CH1_VOLTAGE_N MCURRENTSENS_MUX_CH3
#define	MCURRENTSENS_MUX_CH2_VOLTAGE_P MCURRENTSENS_MUX_CH4
#define	MCURRENTSENS_MUX_CH2_VOLTAGE_N MCURRENTSENS_MUX_CH5
#define	MCURRENTSENS_MUX_CH2_CURRENT_P MCURRENTSENS_MUX_CH6
#define	MCURRENTSENS_MUX_CH2_CURRENT_N MCURRENTSENS_MUX_CH7
#define	MCURRENTSENS_RESERVED_24_DEFAULT 0x900000ul
	mCurrent Sens reserved register setting.
#define	MCURRENTSENS_RESERVED_8_DEFAULT 0x30
#define	MCURRENTSENS_RESERVED_16_DEFAULT 0x000F
#define	MCURRENTSENS_OFFSETCAL_DEFAULT 0x000000ul
	mCurrent Sens calibration register setting.
#define	MCURRENTSENS_GAINCAL_DEFAULT 0x800000ul
#define	MCURRENTSENS_LOCK_UNLOCK 0xA5
	mCurrent Sens LOCK register setting.
#define	MCURRENTSENS_LOCK_LOCK 0x00
#define	MCURRENTSENS_CH1_GAIN_OPAMP 50.0f
	mCurrent Sens board coefficient setting.
#define	MCURRENTSENS_CH1_R5_RSHUNT 0.05f
#define	MCURRENTSENS_CH1_CURRENT_COEFF ( MCURRENTSENS_CH1_GAIN_OPAMP * MCURRENTSENS_CH1_R5_RSHUNT )
#define	MCURRENTSENS_CH2_GAIN_OPAMP 50.0f
#define	MCURRENTSENS_CH2_R8_RSHUNT 0.05f
#define	MCURRENTSENS_CH2_CURRENT_COEFF ( MCURRENTSENS_CH2_GAIN_OPAMP * MCURRENTSENS_CH2_R8_RSHUNT )
#define	MCURRENTSENS_CH1_GAIN 1.0f
#define	MCURRENTSENS_CH1_R16_TOP 1000.0f
#define	MCURRENTSENS_CH1_R21_BOTTOM 38.3f
#define	MCURRENTSENS_CH1_VOLTAGE_COEFF
#define	MCURRENTSENS_CH2_GAIN 0.5f
#define	MCURRENTSENS_CH2_R15_TOP 1000.0f
#define	MCURRENTSENS_CH2_R17_BOTTOM 38.3f
#define	MCURRENTSENS_CH2_VOLTAGE_COEFF
#define	MCURRENTSENS_TEMPERATURE_OFFSET 80.0f
#define	MCURRENTSENS_TEMPERATURE_COEFF 0.2973f
#define	MCURRENTSENS_VREF_INTERNAL 2.4f
#define	MCURRENTSENS_V_TO_MV 1000.0f
#define	MCURRENTSENS_GAIN_ADC 1.0f
#define	MCURRENTSENS_ADC_FS_CODE 8388608.0f
#define	MCURRENTSENS_SAMPLE_COUNT 50
#define	MCURRENTSENS_DATA_READY_TIMEOUT_MS 200
#define	MCURRENTSENS_CURRENT_TARGET_0_MA 0.0f
#define	MCURRENTSENS_CURRENT_TARGET_10_MA 10.0f
#define	MCURRENTSENS_VOLTAGE_TARGET_0_MV 0.0f
#define	MCURRENTSENS_VOLTAGE_TARGET_3000_MV 3000.0f
#define	MCURRENTSENS_EEPROM_ADDR_START 0x00
	mCurrent Sens memory size setting.
#define	MCURRENTSENS_EEPROM_ADDR_END 0xFF
#define	MCURRENTSENS_EEPROM_PAGE_SIZE 16
#define	MCURRENTSENS_DEVICE_ADDRESS 0x57
	mCurrent Sens device address setting.
#define	MCURRENTSENS_DEVICE_ADDRESS_WP 0x37
#define	MCURRENTSENS_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
	Data sample selection.
#define	MCURRENTSENS_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
#define	MCURRENTSENS_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	mcurrentsens_return_value_t { MCURRENTSENS_OK = 0 , MCURRENTSENS_ERROR = -1 }
	mCurrent Sens Click return value data. More...

Functions
void	mcurrentsens_cfg_setup (mcurrentsens_cfg_t *cfg)
	mCurrent Sens configuration object setup function.
err_t	mcurrentsens_init (mcurrentsens_t ctx, mcurrentsens_cfg_t cfg)
	mCurrent Sens initialization function.
err_t	mcurrentsens_default_cfg (mcurrentsens_t *ctx)
	mCurrent Sens default configuration function.
err_t	mcurrentsens_write_reg (mcurrentsens_t *ctx, uint8_t reg, uint8_t data_in)
	mCurrent Sens write register function.
err_t	mcurrentsens_read_reg (mcurrentsens_t ctx, uint8_t reg, uint8_t data_out)
	mCurrent Sens read register function.
err_t	mcurrentsens_write_regs (mcurrentsens_t ctx, uint8_t reg, uint8_t data_in, uint8_t len)
	mCurrent Sens write multiple registers function.
err_t	mcurrentsens_read_regs (mcurrentsens_t ctx, uint8_t reg, uint8_t data_out, uint8_t len)
	mCurrent Sens read multiple registers function.
err_t	mcurrentsens_write_reg16 (mcurrentsens_t *ctx, uint8_t reg, uint16_t data_in)
	mCurrent Sens write 16-bit register function.
err_t	mcurrentsens_read_reg16 (mcurrentsens_t ctx, uint8_t reg, uint16_t data_out)
	mCurrent Sens read 16-bit register function.
err_t	mcurrentsens_write_reg24 (mcurrentsens_t *ctx, uint8_t reg, uint32_t data_in)
	mCurrent Sens write 24-bit register function.
err_t	mcurrentsens_read_reg24 (mcurrentsens_t ctx, uint8_t reg, uint32_t data_out)
	mCurrent Sens read 24-bit register function.
err_t	mcurrentsens_send_fast_cmd (mcurrentsens_t *ctx, uint8_t cmd)
	mCurrent Sens send fast command function.
err_t	mcurrentsens_check_com (mcurrentsens_t *ctx)
	mCurrent Sens communication check function.
err_t	mcurrentsens_set_mux (mcurrentsens_t *ctx, uint8_t vin_p, uint8_t vin_n)
	mCurrent Sens set MUX function.
err_t	mcurrentsens_set_gain (mcurrentsens_t *ctx, uint8_t gain)
	mCurrent Sens set gain function.
err_t	mcurrentsens_set_osr (mcurrentsens_t *ctx, uint8_t osr)
	mCurrent Sens set OSR function.
err_t	mcurrentsens_set_mode (mcurrentsens_t *ctx, uint8_t mode)
	mCurrent Sens set mode function.
err_t	mcurrentsens_get_irq (mcurrentsens_t ctx, uint8_t data_out)
	mCurrent Sens get IRQ function.
err_t	mcurrentsens_set_offset_cal (mcurrentsens_t *ctx, int32_t data_in)
	mCurrent Sens set offset calibration function.
err_t	mcurrentsens_get_offset_cal (mcurrentsens_t ctx, int32_t data_out)
	mCurrent Sens get offset calibration function.
err_t	mcurrentsens_set_gain_cal (mcurrentsens_t *ctx, uint32_t data_in)
	mCurrent Sens set gain calibration function.
err_t	mcurrentsens_get_gain_cal (mcurrentsens_t ctx, uint32_t data_out)
	mCurrent Sens get gain calibration function.
err_t	mcurrentsens_en_dig_cal (mcurrentsens_t *ctx, uint8_t en_offset, uint8_t en_gain)
	mCurrent Sens enable digital calibration function.
err_t	mcurrentsens_apply_calib (mcurrentsens_t *ctx, mcurrentsens_calib_t cal)
	mCurrent Sens apply channel calibration function.
err_t	mcurrentsens_wait_data_ready (mcurrentsens_t *ctx)
	mCurrent Sens wait data ready function.
err_t	mcurrentsens_read_adc (mcurrentsens_t ctx, int32_t data_out)
	mCurrent Sens read ADC data function.
err_t	mcurrentsens_read_adc_avg (mcurrentsens_t ctx, uint8_t sample_count, int32_t data_out)
	mCurrent Sens read averaged ADC function.
err_t	mcurrentsens_read_voltage_avg (mcurrentsens_t ctx, uint8_t sample_count, float data_out)
	mCurrent Sens read averaged voltage function.
err_t	mcurrentsens_read_ch1_current (mcurrentsens_t ctx, float data_out)
	mCurrent Sens read channel 1 current function.
err_t	mcurrentsens_read_ch1_voltage (mcurrentsens_t ctx, float data_out)
	mCurrent Sens read channel 1 voltage function.
err_t	mcurrentsens_read_ch2_current (mcurrentsens_t ctx, float data_out)
	mCurrent Sens read channel 2 current function.
err_t	mcurrentsens_read_ch2_voltage (mcurrentsens_t ctx, float data_out)
	mCurrent Sens read channel 2 voltage function.
err_t	mcurrentsens_read_temperature (mcurrentsens_t ctx, float data_out)
	mCurrent Sens read temperature function.
float	mcurrentsens_adc_to_mv (int32_t adc_code, float gain_adc)
	mCurrent Sens convert ADC code to millivolts function.
void	mcurrentsens_calculate_calib (mcurrentsens_calib_t *calib, float offset_coeff, float target_1, float measured_1, float target_2, float measured_2)
	mCurrent Sens calculate calibration function.
err_t	mcurrentsens_write_memory (mcurrentsens_t ctx, uint8_t address, uint8_t data_in, uint8_t len)
	mCurrent Sens write memory function.
err_t	mcurrentsens_read_memory (mcurrentsens_t ctx, uint8_t address, uint8_t data_out, uint8_t len)
	mCurrent Sens read memory function.
err_t	mcurrentsens_store_calib (mcurrentsens_t *ctx)
	mCurrent Sens store calibration function.
err_t	mcurrentsens_fetch_calib (mcurrentsens_t *ctx)
	mCurrent Sens fetch calibration function.
uint8_t	mcurrentsens_get_irq_pin (mcurrentsens_t *ctx)
	mCurrent Sens get IRQ pin function.
uint8_t	mcurrentsens_get_clk_pin (mcurrentsens_t *ctx)
	mCurrent Sens get CLK pin function.

Detailed Description

This file contains API for mCurrent Sens Click Driver.

Enumeration Type Documentation

◆ mcurrentsens_return_value_t

enum mcurrentsens_return_value_t

mCurrent Sens Click return value data.

Predefined enum values for driver return values.

Enumerator
MCURRENTSENS_OK
MCURRENTSENS_ERROR

Data Structures

Macros

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ mcurrentsens_return_value_t